//Copyright (C) 2006 Richard J. Northedge
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

//This file is based on the GenderEnum.java source file found in the
//original java implementation of OpenNLP.  That source file contains the following header:

//Copyright (C) 2003 Thomas Morton
//
//This library is free software; you can redistribute it and/or
//modify it under the terms of the GNU Lesser General Public
//License as published by the Free Software Foundation; either
//version 2.1 of the License, or (at your option) any later version.
//
//This library is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU Lesser General Public License for more details.
//
//You should have received a copy of the GNU Lesser General Public
//License along with this program; if not, write to the Free Software
//Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

using System;

namespace OpenNLP.Tools.Coreference.Similarity
{
	/// <summary>
    /// Enumeration of gender types.
    /// </summary>
	public class GenderEnum
	{
		private string mGender;

        private GenderEnum(string gender)
        {
            mGender = gender;
        }

        public override string ToString()
        {
            return mGender;
        }

		/// <summary>
        /// Male gender.
        /// </summary>
		public static readonly GenderEnum Male = new GenderEnum("male");

		/// <summary>
        /// Female gender.
        /// </summary>
		public static readonly GenderEnum Female = new GenderEnum("female");

		/// <summary>
        /// Neuter gender.
        /// </summary>
		public static readonly GenderEnum Neuter = new GenderEnum("neuter");
		
        /// <summary>
        /// Unknown gender.
        /// </summary>
		public static readonly GenderEnum Unknown = new GenderEnum("unknown");
	}
}